<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Arduino Humidity Sensor Library: HumidityHIH4030 Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Arduino Humidity Sensor Library
   </div>
   <div id="projectbrief">Arduino library for retrieving data from Honeywell&#39;s HIH4030 Humidity sensor</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_humidity_h_i_h4030.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_humidity_h_i_h4030-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">HumidityHIH4030 Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Arduino library for retrieving data from Honeywell's HIH4030 Humidity sensor.  
</p>

<p><code>#include &lt;<a class="el" href="_humidity_h_i_h4030_8h_source.html">HumidityHIH4030.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for HumidityHIH4030:</div>
<div class="dyncontent">
<div class="center"><img src="class_humidity_h_i_h4030__coll__graph.png" border="0" usemap="#_humidity_h_i_h4030_coll__map" alt="Collaboration graph"/></div>
<map name="_humidity_h_i_h4030_coll__map" id="_humidity_h_i_h4030_coll__map">
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1eda78b2277fdb6a383e835d44ea0619"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1eda78b2277fdb6a383e835d44ea0619"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_humidity_h_i_h4030.html#a1eda78b2277fdb6a383e835d44ea0619">HumidityHIH4030</a> ()</td></tr>
<tr class="memdesc:a1eda78b2277fdb6a383e835d44ea0619"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br/></td></tr>
<tr class="memitem:a4593f2fc532aff92eaaa1497a7ed3b34"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4593f2fc532aff92eaaa1497a7ed3b34"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_humidity_h_i_h4030.html#a4593f2fc532aff92eaaa1497a7ed3b34">begin</a> ()</td></tr>
<tr class="memdesc:a4593f2fc532aff92eaaa1497a7ed3b34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Begin using default values: humidityPin = A0. <br/></td></tr>
<tr class="memitem:a7973893419379dfd5a6a662f215fbdf5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_humidity_h_i_h4030.html#a7973893419379dfd5a6a662f215fbdf5">begin</a> (int humidityPin)</td></tr>
<tr class="memdesc:a7973893419379dfd5a6a662f215fbdf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Begin with user selected analog inputpin.  <a href="#a7973893419379dfd5a6a662f215fbdf5"></a><br/></td></tr>
<tr class="memitem:a2df9aa2f14fdc21c6a3a96bebddabea2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2df9aa2f14fdc21c6a3a96bebddabea2"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_humidity_h_i_h4030.html#a2df9aa2f14fdc21c6a3a96bebddabea2">getHumidityRaw</a> ()</td></tr>
<tr class="memdesc:a2df9aa2f14fdc21c6a3a96bebddabea2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the humidity as a raw value: ADC output: 0 -&gt; 1023. <br/></td></tr>
<tr class="memitem:a30f3b497f09cdf214c632a122ac0464c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_humidity_h_i_h4030.html#a30f3b497f09cdf214c632a122ac0464c">getHumidityPercentage</a> ()</td></tr>
<tr class="memdesc:a30f3b497f09cdf214c632a122ac0464c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the relative humidity percentage. Should be between 0% and 100%.  <a href="#a30f3b497f09cdf214c632a122ac0464c"></a><br/></td></tr>
<tr class="memitem:a8469db71619ced58996d6e96279ec771"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8469db71619ced58996d6e96279ec771"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_humidity_h_i_h4030.html#a8469db71619ced58996d6e96279ec771">setTemperature</a> (int temperature)</td></tr>
<tr class="memdesc:a8469db71619ced58996d6e96279ec771"><td class="mdescLeft">&#160;</td><td class="mdescRight">setTemperature: set the room temperature (used in humidity calculation)(default value: 20° Celsius). <br/></td></tr>
</table>
<h2>Member Function Documentation</h2>
<a class="anchor" id="a7973893419379dfd5a6a662f215fbdf5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void HumidityHIH4030::begin </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>humidityPin</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Default Temperature: 20° Celcius </p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_humidity_h_i_h4030_a7973893419379dfd5a6a662f215fbdf5_cgraph.png" border="0" usemap="#class_humidity_h_i_h4030_a7973893419379dfd5a6a662f215fbdf5_cgraph" alt=""/></div>
<map name="class_humidity_h_i_h4030_a7973893419379dfd5a6a662f215fbdf5_cgraph" id="class_humidity_h_i_h4030_a7973893419379dfd5a6a662f215fbdf5_cgraph">
<area shape="rect" id="node3" href="class_humidity_h_i_h4030.html#a8469db71619ced58996d6e96279ec771" title="setTemperature: set the room temperature (used in humidity calculation)(default value: 20° Celsius)..." alt="" coords="220,5,444,35"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a30f3b497f09cdf214c632a122ac0464c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float HumidityHIH4030::getHumidityPercentage </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Check the output for invalid data: over or under 100 (how to report?) </dd></dl>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_humidity_h_i_h4030_a30f3b497f09cdf214c632a122ac0464c_cgraph.png" border="0" usemap="#class_humidity_h_i_h4030_a30f3b497f09cdf214c632a122ac0464c_cgraph" alt=""/></div>
<map name="class_humidity_h_i_h4030_a30f3b497f09cdf214c632a122ac0464c_cgraph" id="class_humidity_h_i_h4030_a30f3b497f09cdf214c632a122ac0464c_cgraph">
<area shape="rect" id="node3" href="class_humidity_h_i_h4030.html#a2df9aa2f14fdc21c6a3a96bebddabea2" title="Returns the humidity as a raw value: ADC output: 0 &#45;&gt; 1023." alt="" coords="260,13,489,43"/></map>
</div>
</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_humidity_h_i_h4030.html">HumidityHIH4030</a></li>
    <li class="footer">Generated on Sun Dec 23 2012 03:16:01 for Arduino Humidity Sensor Library by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.2 </li>
  </ul>
</div>
</body>
</html>
